Schedule

interface Schedule

Defines a schedule for the playback of a Playlist or display of a Template within the RevelDigital player.

A Schedule specifies the date range (start and end dates), the time range within a day (start and end times), and the specific days of the week on which the associated content should be active. It can also include additional Conditions that must be met for the schedule to apply.

For a schedule to be considered "active" or "valid" at any given moment, the current date and time must fall within all specified ranges, the current day must be one of the selected days of the week, and all conditions must evaluate to true.

Note on Date objects:

  • getStartDate and getEndDate are concerned with the date part only. Time components within these Date objects are typically ignored or normalized.
  • getStartTime and getEndTime are concerned with the time part only (hours, minutes, seconds). Date components within these Date objects are typically ignored or normalized to a common epoch.

See also

Functions

Link copied to clipboard
abstract fun getConditions(): Iterator<out Condition>
Gets an iterator over additional Conditions that must be met for this schedule to be considered active.
Link copied to clipboard
abstract fun getDays(): EnumSet<DayOfWeekType>
Gets the set of days of the week on which this schedule is active.
Link copied to clipboard
abstract fun getEndDate(): Date
Gets the end date for this schedule's validity period.
Link copied to clipboard
abstract fun getEndTime(): Date
Gets the end time of day for this schedule's active period.
Link copied to clipboard
abstract fun getName(): String
Gets the user-defined name of this schedule.
Link copied to clipboard
abstract fun getPlaylist(): Playlist
Gets the Playlist associated with this schedule.
Link copied to clipboard
abstract fun getStartDate(): Date
Gets the start date for this schedule's validity period.
Link copied to clipboard
abstract fun getStartTime(): Date
Gets the start time of day for this schedule's active period.
Link copied to clipboard
abstract fun getTemplate(): Template
Gets the Template associated with this schedule.